home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / workbench erweiterungen / wbtitle / wbtitle.doc < prev    next >
Text File  |  1996-04-07  |  5KB  |  150 lines
  1. WBTitle Documentation
  2.  
  3. Designed and Implemented by Mark Thomas
  4. This software is placed in the public domain.
  5. You may modify the program or use the code in anyway you see fit.
  6. I make no claims as to the code's fitness for use in any setting.
  7. I make no claims as to the program's fitness for use in any setting.
  8. Use the code or program at your own risk.
  9.  
  10.  
  11. Motivation
  12.  
  13. I was reading someone's message on Usenet when something he said made
  14. me come up with the idea for this program.  The actual technical
  15. notion came from comments in the docs for the VMM virtual memory
  16. program by Martin Apel.  Thanks for the clue on patching Intuition.
  17.  
  18. I also was concerned that there might not be any good source code
  19. example on how to do SetFunction() from C.  The source code for this
  20. program is in the archive.
  21.  
  22.  
  23. Overview
  24.  
  25. WBTitle is a program that lets you replace your Workbench title bar
  26. with just about any text you like.  It also gives you the facilities
  27. to put memory readings in the title bar.  At its simplest, you could
  28. replace the title bar with the same text that is already there, and
  29. in the exact same format.  But WBTitle allows you to do more.
  30.  
  31.  
  32. Features
  33.  
  34. The title bar replacement is partitioned into three main parts,
  35. prefix, memory, and postfix.  They are combined in the order
  36. prefix-memory-postfix to make the title bar text.
  37.  
  38. The prefix is just a string of text that appears at the leftmost part
  39. of the title bar.  The memory consists of memory strings.  There can
  40. be several items in the memory section, shown shortly.  The postfix
  41. is simply some text that appears at the end of the title bar text.
  42.  
  43. As stated above, the memory can have several parts.  Each part is a
  44. memory reading (amount of free memory with a label).  The memory
  45. displays that are available are chip, fast, public, total, virtual,
  46. and retina.  Chip, fast, public, and total are normal Amiga memory
  47. options.  Virtual is for use with the VMM program for showing free
  48. virtual memory.  Retina is for use with a Retina graphics card for
  49. showing the amount of free graphics memory.
  50.  
  51. The memory reading consists of the memory value and a label (some
  52. text).  All labels come either before the memory value or after the
  53. memory value, which is determined by the LABELS option described
  54. below.
  55.  
  56.  
  57. Requirement
  58.  
  59. For the VMM virtual memory option to work, the library that comes
  60. with VMM, "vmm.library", will have to be placed in LIBS:.
  61.  
  62.  
  63. Options
  64.  
  65. All the options are specified in the tool types to keep the program
  66. size small.  Tool types are entered from the Workbench by clicking
  67. on the WBTitle icon and choosing Information... from the Icons menu.
  68. Here are the tool types:
  69.  
  70. PREFIX
  71.  
  72. Lets you set the prefix text.
  73. Default: "PREFIX=Amiga Workbench "
  74.  
  75. SUFFIX
  76.  
  77. Lets you set the suffix text.
  78. Default: "SUFFIX="
  79.  
  80. LABELS
  81.  
  82. Lets you specify if the memory labels are placed before or after
  83. the memory values so that you can do things like "Chip: 1,232,848"
  84. or "1,012 KB Chip Mem".
  85.  
  86. MEMORDER
  87.  
  88. Allows you to set the order of the memory readings, as well as which
  89. memory values are to be used.  It consists of a several letters that
  90. you arrange in the order you want the readings.  Each letter stands
  91. for a particular memory type:  C for chip, F for fast, P for public,
  92. T for total, V for virtual, and R for Retina.
  93. Default: "MEMORDER=CVPR"
  94.  
  95. CHIP
  96.  
  97. Lets you set the text that appears with the chip memory reading.
  98. Default: "CHIP= Chip"
  99.  
  100. FAST
  101.  
  102. Lets you set the text that appears with the fast memory reading.
  103. Default: "FAST= Fast"
  104.  
  105. PUBLIC
  106.  
  107. Lets you set the text that appears with the public memory reading.
  108. Default: "PUBLIC= Public"
  109.  
  110. TOTAL
  111.  
  112. Lets you set the text that appears with the total memory reading.
  113. Default: "TOTAL= Total"
  114.  
  115. VIRTUAL
  116.  
  117. Lets you set the text that appears with the virtual memory reading.
  118. Default: "VIRTUAL= Virtual"
  119.  
  120. RETINA
  121.  
  122. Lets you set the text that appears with the retina memory reading.
  123. Default: "RETINA= Retina"
  124.  
  125. THOUSANDSEP
  126.  
  127. Lets you choose whether memory values have a seperator before each
  128. thousands group or not.  If this is set, your memory values would
  129. have the format "1,228,352".  If this is not specified, your memory
  130. values would have the foramt "1228352".
  131. Default: there is not default
  132.  
  133. SEPERATOR
  134.  
  135. Allows you to set the character used to seperate the thousands groups
  136. in memory values.  This is to allow for other countries.
  137. Default: "SEPERATOR=,"
  138.  
  139. UNITS
  140.  
  141. Allows you to set the accuracy of the memory values.  It's easiest
  142. to show an example.  If you have a memory value 1,228,352 and this
  143. is set to 1, then that's exactly what you see, 1,228,352.  If you
  144. wanted to see only how many kilobytes you have free, you can set the
  145. value to 1024 and you would see 1,199, since that's the number of
  146. kilobytes in 1,228,352.  So whatever value is the real memory
  147. setting, it gets divided by this value.  Setting to 0 will end up as
  148. a setting of 1 so that divides by zero are avoided.
  149. Default: "UNITS=1"
  150.